CI: Build DocC catalog on every PR (#22)#32
Merged
Merged
Conversation
Add a partial GitHub Actions workflow with a DocC generation job that runs on every PR and push to master. The check fails on documentation warnings and uploads the rendered archive as a PR artifact. Closes #22
The public Peripheral initializer doc comment referenced the internal PeripheralManager type, causing generate-documentation to fail. Replace the symbol link with plain prose so the new CI DocC check passes.
DocC output includes filenames with colons (e.g. operator docs) that upload-artifact rejects on NTFS-safe paths. Zip the .doccarchive bundle before uploading so PR reviewers can still download a preview.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds an initial GitHub Actions CI workflow job to validate DocC generation on every PR and on pushes to master, and adjusts a public API doc comment to avoid referencing an internal type that breaks DocC builds.
Changes:
- Add a “DocC catalog” CI job that runs
swift package generate-documentation --warnings-as-errorsand uploads the generated.doccarchiveas an artifact. - Update the
Peripheralinitializer doc comment to remove a DocC symbol link to an internalPeripheralManagertype.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
Sources/ReliaBLE/Models/Peripheral.swift |
Updates a doc comment to avoid an invalid DocC link to an internal type. |
.github/workflows/ci.yml |
Introduces a CI workflow job to build DocC docs and upload the archive as a PR artifact. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Correct Peripheral init docs to point at discoveredPeripherals publisher - Write DocC output to ./docc-output via --output-path instead of .build plugin path - Add Xcode 16.4 existence check with installed-version diagnostics - Ignore docc-output/ build directory
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the first job to the CI pipeline scaffold: a DocC generation check that runs on every PR and push to
master.swift package generate-documentation --target ReliaBLE --warnings-as-errorsReliaBLE.doccarchive.zipas a PR artifact for reviewer previewThis is the DocC sub-issue of #21 (full CI). Build/test/lint jobs will be added to the same workflow in a follow-up.
Also fixes a pre-existing DocC failure on
master: the publicPeripheralinitializer doc comment linked to the internalPeripheralManagertype.How to preview docs from a PR
ReliaBLE.doccarchive.zipReliaBLE.doccarchivein Xcode via File → Open Documentation Catalog, or use DocC previewCloses #22